home *** CD-ROM | disk | FTP | other *** search
- 17
- --- RECORDSEPARATOR ---
-
- --- RECORDSEPARATOR ---
- WriteIni
- --- RECORDSEPARATOR ---
- Platform:
- --- RECORDSEPARATOR ---
-
- --- RECORDSEPARATOR ---
- Windows and Macintosh.
- --- RECORDSEPARATOR ---
-
- --- RECORDSEPARATOR ---
- Description:
- --- RECORDSEPARATOR ---
-
- --- RECORDSEPARATOR ---
- baWriteIni writes a string into a Windows style ini file.
- --- RECORDSEPARATOR ---
-
- --- RECORDSEPARATOR ---
- Usage:
- --- RECORDSEPARATOR ---
-
- --- RECORDSEPARATOR ---
- Result = baWriteIni( Section, Keyname, NewValue, IniFile )
- --- RECORDSEPARATOR ---
-
- --- RECORDSEPARATOR ---
- Arguments:
- --- RECORDSEPARATOR ---
-
- --- RECORDSEPARATOR ---
- String, String, String, String.
- --- RECORDSEPARATOR ---
- Section is the section name of the ini file.
- --- RECORDSEPARATOR ---
- Keyname is the name of the key
- --- RECORDSEPARATOR ---
- NewValue is the string to write into the file.
- --- RECORDSEPARATOR ---
- IniFile is the name if the ini file to use.
- --- RECORDSEPARATOR ---
-
- --- RECORDSEPARATOR ---
- Returns:
- --- RECORDSEPARATOR ---
-
- --- RECORDSEPARATOR ---
- Integer.
- --- RECORDSEPARATOR ---
- Returns 1 if the function was successful, else 0.
- --- RECORDSEPARATOR ---
-
- --- RECORDSEPARATOR ---
- Examples:
- --- RECORDSEPARATOR ---
-
- --- RECORDSEPARATOR ---
- Director:
- --- RECORDSEPARATOR ---
- set OK = baWriteIni( "CurrentUser", "UserName", "Gary Smith", "Userdat.ini" )
- --- RECORDSEPARATOR ---
- Authorware:
- --- RECORDSEPARATOR ---
- OK := baWriteIni( "CurrentUser", "UserName", "Gary Smith", "Userdat.ini" )
- --- RECORDSEPARATOR ---
-
- --- RECORDSEPARATOR ---
- Notes:
- --- RECORDSEPARATOR ---
-
- --- RECORDSEPARATOR ---
- An entry in a Windows ini file has the following format :
- --- RECORDSEPARATOR ---
- [Section]
- --- RECORDSEPARATOR ---
- Keyname=string
- --- RECORDSEPARATOR ---
- This function will write the string after the equals sign. When using this function,
- --- RECORDSEPARATOR ---
- the Section name you use should not include the square brackets around the
- --- RECORDSEPARATOR ---
- name. The Keyname should not include the equals sign. For example the ini file for
- --- RECORDSEPARATOR ---
- the example above might look something like this
- --- RECORDSEPARATOR ---
- [CurrentUser]
- --- RECORDSEPARATOR ---
- UserName=Gary Smith
- --- RECORDSEPARATOR ---
- Password=mypw
- --- RECORDSEPARATOR ---
- ModulesCompleted=4
- --- RECORDSEPARATOR ---
- The IniFile can be in any directory. On
- --- RECORDSEPARATOR ---
- Windows
- --- RECORDSEPARATOR ---
- if the full path name is not
- --- RECORDSEPARATOR ---
- specified, the file will be created in the Windows directory, on the
- --- RECORDSEPARATOR ---
- Macintosh
- --- RECORDSEPARATOR ---
- it will
- --- RECORDSEPARATOR ---
- be created in the Preferences folder.
- --- RECORDSEPARATOR ---
- The ini file does not have to have an .ini extension: any extension can be used. If
- --- RECORDSEPARATOR ---
- the ini file does not exist, then it will be created.
- --- RECORDSEPARATOR ---
- This function will write a maximum of
- --- RECORDSEPARATOR ---
- 32000 characters.
- --- RECORDSEPARATOR ---
- On Win95, strings written to an ini file can not contain a tab character.
- --- RECORDSEPARATOR ---
-
- --- RECORDSEPARATOR ---
- See also:
- --- RECORDSEPARATOR ---
-
- --- RECORDSEPARATOR ---
- baReadIni
- --- RECORDSEPARATOR ---
- baFlushIni
- --- RECORDSEPARATOR ---
- baDeleteIniEntry
- --- RECORDSEPARATOR ---
- baDeleteIniSection